﻿#region Copyright(c) 2006 ZO, All right reserved.
// -----------------------------------------------------------------------------
// Copyright(c) 2006 ZO, All right reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//   1.  Redistribution of source code must retain the above copyright notice,
//       this list of conditions and the following disclaimer.
//   2.  Redistribution in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//   3.  The name of the author may not be used to endorse or promote products
//       derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
// EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// -----------------------------------------------------------------------------
#endregion


#region Using directives

using ZO.SmartCore.IO;
using ZO.SmartCore.Xml;

#endregion

namespace ZO.SmartCore.Configuration
{
    /// <summary>
    /// The base interface for all of providers used to load and save configuration
    /// </summary>
    public interface IConfigurationProvider
    {


        #region Events

        #endregion

        #region Properties
        /// <summary>
        /// Get The Name of Storage used by the Provider
        /// </summary>
        /// <value>storage name.</value>
        string Name { get; }
        #endregion

        #region Methods
        /// <summary>
        /// load the file to MemoryStream
        /// </summary>
        /// <param name="file">The file.</param>
        /// <returns>MemoryStream containing the loaded file</returns>
        StringStream Load(string file);


        /// <summary>
        /// Gets the XML document from provider.
        /// </summary>
        /// <param name="file">The file.</param>
        /// <returns></returns>
        Document GetXmlDocument(string file);



        /// <summary>
        /// Saves the XML document to provider data space .
        /// </summary>
        /// <param name="file">The file.</param>
        /// <param name="xmlDoc">The XML document to save.</param>
        void SaveXmlDocument(string file, Document xmlDoc);


        /// <summary>
        /// Gets all the files names in specified folder.
        /// </summary>
        /// <param name="directoryName">Name of the directory.</param>
        /// <returns>All files name in specified folder</returns>
        string[] GetFilesNames(string directoryName);


        /// <summary>
        /// Gets all the files names in specified folder.
        /// </summary>
        /// <param name="directoryName">Name of the directory.</param>
        /// <param name="searchPattern">The search string to match against the names of files in path.</param>
        /// <returns>
        /// All files name in specified folder with specified file name
        /// </returns>
        string[] GetFilesNames(string directoryName, string searchPattern);


        /// <summary>
        /// Saves the specified configuration.
        /// </summary>
        /// <param name="file">The file name to save.</param>
        /// <param name="contents">The contents.</param>
        void Save(string file, StringStream contents);

        /// <summary>
        /// Creates the directory.
        /// </summary>
        /// <param name="directory">The path of the directory to create.</param>
        void CreateDirectory(string directory);


        /// <summary>
        /// Deletes the directory.
        /// </summary>
        /// <param name="directory">The directory.</param>
        void DeleteDirectory(string directory);

        /// <summary>
        /// Deletes the File.
        /// </summary>
        /// <param name="fileName">Name of the file.</param>
        void DeleteFile(string fileName);

        /// <summary>
        /// Get Whether specified file exists
        /// </summary>
        /// <param name="fileName">Name of the file.</param>
        /// <returns>true if file exists else false</returns>
        bool FileExists(string fileName);

        /// <summary>
        /// Get Whether specified directory exists
        /// </summary>
        /// <param name="directoryName">Name of the directory.</param>
        /// <returns>true if directory exists else false</returns>
        bool DirectoryExists(string directoryName);


        #endregion

    }
}

